/*-
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      ParseException.hpp
 *
 * $FTS$
 */
#ifndef _PARSE_EXCEPTION_HPP__
#define _PARSE_EXCEPTION_HPP__ 1

/**
  @file ParseException.hpp
  @brief Query string parsing exception
*/
#include <FTSSException.hpp>

namespace FTSS // FullTextSearchSystem
{

/**
  @class ParseException ParseException.hpp <ParseException.hpp>
  @brief Parsing exception
*/
class ParseException:
  public UnknownException
{
private:

	/** Line                */
	UINT_32    iLine;
	/** Line position       */
	UINT_32    iPos;
	/** Error Code          */
	INT_32     iCode;
public:
	/**
	  @brief Constructor
	  @param iILine - line where error occured
	  @param iIPos - line position
	  @param iICode - error code
	*/
	ParseException(UINT_32 iILine, UINT_32 iIPos, INT_32 iICode) throw(): iLine(iILine), iPos(iIPos), iCode(iICode) { ;; }

	/**
	  @brief Get error code
	  @return error code
	*/
	inline INT_32 GetCode()     const throw() { return iCode; }

	/**
	  @brief Get line number
	  @return Line number
	*/
	inline UINT_32 GetLine()    const throw() { return iLine; }

	/**
	  @brief Get position in line
	  @return Position in line
	*/
	inline UINT_32 GetLinePos() const throw() { return iPos; }

	/**
	  @brief Get error description
	  @return Eror description
	*/
	inline CCHAR_P what() const throw() { return "Query parsing error"; }
};

} // namespace FTSS
#endif // _PARSE_EXCEPTION_HPP__
// End.
